API documentation

• effmass.inputs

• effmass.extrema

A module for finding the band structure extrema and instantiating a Segment object for each extrema point.

The extrema are found within an energy range given by the Settings class. Each Segment object contains data for kpoints within an energy range given by the Settings class.

• effmass.dos

A module for analysing DOSCAR data.

• effmass.analysis

A module for analysing the data contained in a Segment object.

Contains the Segment class and methods for calculating various definitions of the effective mass.

• effmass.outputs

A module for plotting and summarising segments information, density-of-states information and effective mass analysis.